Add payload-carrying wakeup to the flow engine via MessagePayload - #229
Merged
Conversation
akashdw
requested review from
derek-miller,
praneethy91,
rdeepak2002 and
ykitaev
July 15, 2026 00:49
ykitaev
approved these changes
Jul 16, 2026
rdeepak2002
approved these changes
Jul 16, 2026
rdeepak2002
left a comment
Collaborator
There was a problem hiding this comment.
lgtm, thanks for the change!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request type
./gradlew build --write-locksto refresh dependencies)NOTE: Please remember to run
./gradlew spotlessApplyto fix any format violations.Changes in this PR
Add payload-carrying wakeup to the flow engine
What
Flow-engine wakeups today carry only an
int code. This adds an optional structured payload that rides alongside the code, from the wakeup entrypoint all the way down to the task'sexecute, so a step can read caller-supplied context when it wakes up instead of inferring everything from the code.How
MessagePayload— new polymorphic interface with aDefaultMessagePayloadsubtype. AMessagePayload.DEFAULTsentinel is used everywhere in place ofnull, so no nullable payloads flow through the engine.Action.FlowWakeUp/TaskWakeUp/TaskActivate/TaskPingcarry the payload;GroupActor→FlowActor→TaskActorpass it down.Taskgets amessagePayloadscratch field, set beforeexecuteand reset in afinally(same handoff shape as the existingcodefield), so a payload never leaks into the task'scloneTaskserialization.FlowExecutor.wakeUp/FlowOperation.wakeUpgain a payload overload; the int-only overloads delegate withMessagePayload.DEFAULT.FlowActordedup preserves current behavior for the default (code=0, DEFAULT payload) case, so internal polling is unchanged.RestBasedFlowOperationandFlowEngineControllerget payload-carrying endpoints for both flow-ref (/tasks/{taskReference}/message/{code}) and workflow-ref (.../steps/{stepId}/message/{code}) addressing, routing cross-node the same way as the existing wakeup.Notes
TaskActorTest,FlowActorTest,GroupActorTest,FlowExecutorTest,FlowEngineControllerTest,RestBasedFlowOperationTest, plus round-trip serde inMessagePayloadTest.